GET PlanCare2Api/Goals?careplanIds[0]={careplanIds[0]}&careplanIds[1]={careplanIds[1]}
Retrieve all goals for the selected careplans.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| careplanIds |
The ids of the careplans for which to fetch the goals. |
Collection of integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of goals from all care demands that belong to the careplans.
Collection of Goal| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The internal id of the goal. |
integer |
- |
| Description |
The description of the goal. |
string |
- |
| InitialSituation |
The description of the initial situation. |
string |
- |
| TargetSituation |
The description of the desired situation. |
string |
- |
| ClientId |
The id of the client. |
integer |
- |
| ClientplanId |
The id of the clientplan. |
integer |
- |
| Status |
The status of the goal. |
ClientplanPartGoalStatus |
- |
| StatusDate |
The status date of the goal. |
date |
Nullable |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": 1,
"Description": "sample string 2",
"InitialSituation": "sample string 3",
"TargetSituation": "sample string 4",
"ClientId": 5,
"ClientplanId": 6,
"Status": 0,
"StatusDate": "2026-05-26T22:10:18.0441639+02:00"
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfGoal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
<Goal>
<ClientId>5</ClientId>
<ClientplanId>6</ClientplanId>
<Description>sample string 2</Description>
<Id>1</Id>
<InitialSituation>sample string 3</InitialSituation>
<Status>Concept</Status>
<StatusDate>2026-05-26T22:10:18.0441639+02:00</StatusDate>
<TargetSituation>sample string 4</TargetSituation>
</Goal>
<Goal>
<ClientId>5</ClientId>
<ClientplanId>6</ClientplanId>
<Description>sample string 2</Description>
<Id>1</Id>
<InitialSituation>sample string 3</InitialSituation>
<Status>Concept</Status>
<StatusDate>2026-05-26T22:10:18.0441639+02:00</StatusDate>
<TargetSituation>sample string 4</TargetSituation>
</Goal>
</ArrayOfGoal>